Use consistent formatting for CoreCLR repo link #4920
Conversation
mairaw
left a comment
mairaw
left a comment
There was a problem hiding this comment.
Thank you @Mackiovello for your contribution. I left a note on how we usually style GitHub repo links. Please take a look!
docs/core/build/index.md
Outdated
| ## Build the CLR from source | ||
|
|
||
| The source code for the .NET CoreCLR can be found in [the `dotnet/coreclr` repository on GitHub](https://github.com/dotnet/coreclr/). | ||
| The source code for the .NET CoreCLR can be found in [the CoreCLR repository on GitHub](https://github.com/dotnet/coreclr/). |
There was a problem hiding this comment.
When we refer to repo names, we usually refer to them as the GitHub path. The sentence as it was tells users what it is: the .NET CoreCLR and where it is: dotnet/coreclr.
So for consistency, I'd keep it like that.
However, I think we can improve the readability of that sentence by making a change like this:
can be found in the [dotnet\coreclr](https://github.com/dotnet/coreclr/) repository on GitHub.
There was a problem hiding this comment.
That makes sense. I wanted to make it consistent with the link further down the page that looks like this:
at the base of [the CoreCLR repository](https://github.com/dotnet/coreclr/)
I'll make both of them the same format then: the [org-name/repo-name] repository
There was a problem hiding this comment.
Good catch @Mackiovello! Yes, that would be perfect!
The links had different formats. This makes them consistently follow the format of `[org-name/repo-name](link-to-repo)`
mairaw
left a comment
mairaw
left a comment
There was a problem hiding this comment.
Changes look great! Thank you so much @Mackiovello. Your fix should go live within a day or so.
2 participants
No description provided.